<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>robotide.utils.variablematcher</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="robotide-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/robotframework-ride">RIDE</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="robotide-module.html">Package&nbsp;robotide</a> ::
        <a href="robotide.utils-module.html">Package&nbsp;utils</a> ::
        Module&nbsp;variablematcher
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="robotide.utils.variablematcher-module.html">Module robotide.utils.variablematcher</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"> </tt>
<a name="is_variable"></a><div id="is_variable-def"><a name="L4"></a><tt class="py-lineno"> 4</tt> <a class="py-toggle" href="#" id="is_variable-toggle" onclick="return toggle('is_variable');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="robotide.utils.variablematcher-module.html#is_variable">is_variable</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="is_variable-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="is_variable-expanded"><a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt id="link-0" class="py-name" targets="Function robotide.utils.variablematcher.is_scalar_variable()=robotide.utils.variablematcher-module.html#is_scalar_variable"><a title="robotide.utils.variablematcher.is_scalar_variable" class="py-name" href="#" onclick="return doclink('link-0', 'is_scalar_variable', 'link-0');">is_scalar_variable</a></tt><tt class="py-op">(</tt><tt id="link-1" class="py-name" targets="Variable robotide.controller.settingcontrollers.DocumentationController.value=robotide.controller.settingcontrollers.DocumentationController-class.html#value,Variable robotide.controller.settingcontrollers.MetadataController.value=robotide.controller.settingcontrollers.MetadataController-class.html#value,Variable robotide.controller.settingcontrollers.VariableController.value=robotide.controller.settingcontrollers.VariableController-class.html#value,Variable robotide.editor.tags.TagBox.value=robotide.editor.tags.TagBox-class.html#value"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-1', 'value', 'link-1');">value</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt id="link-2" class="py-name" targets="Function robotide.utils.variablematcher.is_list_variable()=robotide.utils.variablematcher-module.html#is_list_variable"><a title="robotide.utils.variablematcher.is_list_variable" class="py-name" href="#" onclick="return doclink('link-2', 'is_list_variable', 'link-2');">is_list_variable</a></tt><tt class="py-op">(</tt><tt id="link-3" class="py-name"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-3', 'value', 'link-1');">value</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"> </tt>
<a name="is_scalar_variable"></a><div id="is_scalar_variable-def"><a name="L7"></a><tt class="py-lineno"> 7</tt> <a class="py-toggle" href="#" id="is_scalar_variable-toggle" onclick="return toggle('is_scalar_variable');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="robotide.utils.variablematcher-module.html#is_scalar_variable">is_scalar_variable</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="is_scalar_variable-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="is_scalar_variable-expanded"><a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">_match_scalar_variable</tt><tt class="py-op">(</tt><tt id="link-4" class="py-name"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-4', 'value', 'link-1');">value</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line"> </tt>
<a name="_match_scalar_variable"></a><div id="_match_scalar_variable-def"><a name="L10"></a><tt class="py-lineno">10</tt> <a class="py-toggle" href="#" id="_match_scalar_variable-toggle" onclick="return toggle('_match_scalar_variable');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="robotide.utils.variablematcher-module.html#_match_scalar_variable">_match_scalar_variable</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_match_scalar_variable-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="_match_scalar_variable-expanded"><a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-string">'^(\${.*?}) ?=?$'</tt><tt class="py-op">,</tt> <tt id="link-5" class="py-name"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-5', 'value', 'link-1');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"> </tt>
<a name="is_list_variable"></a><div id="is_list_variable-def"><a name="L13"></a><tt class="py-lineno">13</tt> <a class="py-toggle" href="#" id="is_list_variable-toggle" onclick="return toggle('is_list_variable');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="robotide.utils.variablematcher-module.html#is_list_variable">is_list_variable</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="is_list_variable-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="is_list_variable-expanded"><a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">_match_list_variable</tt><tt class="py-op">(</tt><tt id="link-6" class="py-name"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-6', 'value', 'link-1');">value</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"> </tt>
<a name="_match_list_variable"></a><div id="_match_list_variable-def"><a name="L16"></a><tt class="py-lineno">16</tt> <a class="py-toggle" href="#" id="_match_list_variable-toggle" onclick="return toggle('_match_list_variable');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="robotide.utils.variablematcher-module.html#_match_list_variable">_match_list_variable</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_match_list_variable-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="_match_list_variable-expanded"><a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-string">'^(\@{.*?})(\ ?=?|\[\d*\])$'</tt><tt class="py-op">,</tt> <tt id="link-7" class="py-name"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-7', 'value', 'link-1');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"> </tt>
<a name="get_variable"></a><div id="get_variable-def"><a name="L19"></a><tt class="py-lineno">19</tt> <a class="py-toggle" href="#" id="get_variable-toggle" onclick="return toggle('get_variable');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="robotide.utils.variablematcher-module.html#get_variable">get_variable</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_variable-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="get_variable-expanded"><a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line">    <tt class="py-docstring">"Returns variables name without equal sign '=' and indexing '[2]' or None"</tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line">    <tt class="py-name">match</tt> <tt class="py-op">=</tt> <tt id="link-8" class="py-name" targets="Variable robotide.ui.tree.VariableHandler.is_variable=robotide.ui.tree.VariableHandler-class.html#is_variable,Function robotide.utils.variablematcher.is_variable()=robotide.utils.variablematcher-module.html#is_variable"><a title="robotide.ui.tree.VariableHandler.is_variable
robotide.utils.variablematcher.is_variable" class="py-name" href="#" onclick="return doclink('link-8', 'is_variable', 'link-8');">is_variable</a></tt><tt class="py-op">(</tt><tt id="link-9" class="py-name"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-9', 'value', 'link-1');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">groups</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">if</tt> <tt class="py-name">match</tt> <tt class="py-keyword">else</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line"> </tt>
<a name="get_variable_basename"></a><div id="get_variable_basename-def"><a name="L24"></a><tt class="py-lineno">24</tt> <a class="py-toggle" href="#" id="get_variable_basename-toggle" onclick="return toggle('get_variable_basename');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="robotide.utils.variablematcher-module.html#get_variable_basename">get_variable_basename</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_variable_basename-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="get_variable_basename-expanded"><a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line">    <tt class="py-docstring">"Return variable without extended variable syntax part"</tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt id="link-10" class="py-name"><a title="robotide.utils.variablematcher.is_list_variable" class="py-name" href="#" onclick="return doclink('link-10', 'is_list_variable', 'link-2');">is_list_variable</a></tt><tt class="py-op">(</tt><tt id="link-11" class="py-name"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-11', 'value', 'link-1');">value</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-12" class="py-name" targets="Function robotide.utils.variablematcher.get_variable()=robotide.utils.variablematcher-module.html#get_variable"><a title="robotide.utils.variablematcher.get_variable" class="py-name" href="#" onclick="return doclink('link-12', 'get_variable', 'link-12');">get_variable</a></tt><tt class="py-op">(</tt><tt id="link-13" class="py-name"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-13', 'value', 'link-1');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line">    <tt class="py-name">match</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-string">'\${(.+?)[^\s\w]+.*?}?'</tt><tt class="py-op">,</tt> <tt id="link-14" class="py-name"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-14', 'value', 'link-1');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">match</tt><tt class="py-op">:</tt> </tt>
<a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-string">'${%s}'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">groups</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line"> </tt>
<a name="find_variable_basenames"></a><div id="find_variable_basenames-def"><a name="L33"></a><tt class="py-lineno">33</tt> <a class="py-toggle" href="#" id="find_variable_basenames-toggle" onclick="return toggle('find_variable_basenames');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="robotide.utils.variablematcher-module.html#find_variable_basenames">find_variable_basenames</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="find_variable_basenames-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="find_variable_basenames-expanded"><a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt id="link-15" class="py-name" targets="Function robotide.utils.variablematcher.get_variable_basename()=robotide.utils.variablematcher-module.html#get_variable_basename"><a title="robotide.utils.variablematcher.get_variable_basename" class="py-name" href="#" onclick="return doclink('link-15', 'get_variable_basename', 'link-15');">get_variable_basename</a></tt><tt class="py-op">(</tt><tt class="py-name">var</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var</tt> <tt class="py-keyword">in</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">findall</tt><tt class="py-op">(</tt><tt class="py-string">'[\@\$]{.*?}'</tt><tt class="py-op">,</tt> <tt id="link-16" class="py-name"><a title="robotide.controller.settingcontrollers.DocumentationController.value
robotide.controller.settingcontrollers.MetadataController.value
robotide.controller.settingcontrollers.VariableController.value
robotide.editor.tags.TagBox.value" class="py-name" href="#" onclick="return doclink('link-16', 'value', 'link-1');">value</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
</div><a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="robotide-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/robotframework-ride">RIDE</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Apr 13 15:09:48 2011
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
